fix: typescript interface updates #973
Conversation
jeeyyy
requested review from
WilcoFiers,
marcysutton,
stephenmathieson and
dylanb
axe.d.ts
Outdated
|
|
||
| type resultGroups = "inapplicable" | "passes" | "incomplete" | "violations"; | ||
| type ResultGroups = "inapplicable" | "passes" | "incomplete" | "violations"; |
There was a problem hiding this comment.
Should this be an enum? That way we get better intellisense/etc
There was a problem hiding this comment.
Possibly, when this definition was first written support for enums wasn't good.
There was a problem hiding this comment.
You are right @marcysutton enums got introduced in ts 2.4 I believe
axe.d.ts
Outdated
|
|
||
| type resultGroups = "inapplicable" | "passes" | "incomplete" | "violations"; | ||
| type ResultGroups = "inapplicable" | "passes" | "incomplete" | "violations"; | ||
|
|
||
| type RunOnlyObject = { |
There was a problem hiding this comment.
This is a confusing name if it isn't being used in runOnly (only in ElementContext)
There was a problem hiding this comment.
It'd be a breaking change to rename it tho, right?
axe.d.ts
Outdated
|
|
||
| type TagValue = "wcag2a" | "wcag2aa" | "section508" | "best-practice"; | ||
| enum TagValue { | ||
| wcag2a = "wcag2a", |
There was a problem hiding this comment.
This will break users' code if they were previously using TagValues.
For example, we're no longer able to call axewebdriverjs#withTags(['wcag2a']), but instead, will need to do axewebdriverjs#withTags([ axe.TagValue.wcag2a ]).
Are we comfortable making a breaking change here?
|
@stephenmathieson But in my experience, that is the idea of typings. I have rolled back to |
jeeyyy
dismissed
stephenmathieson’s stale review
Reverted enum changes, and fixed runOnly interface
PR Checklist
Please check if your PR fulfills the following requirements:
Description of the changes
axe.RunOnly#972Does this PR introduce a breaking change?
Other information